Resource URL: /platform/<<version=1>>/auth/providers/krb5/<ID>

    Overview: This resource applies the standard collection pattern to
              individual Kerberos providers.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the KRB5 provider.

       URL: GET /platform/<<version=1>>/auth/providers/krb5/<ID>

Query arguments:
scope=<enum> Where <enum> is one of user, default, effective.  If specified as
             "effective" or not specified, all fields are returned.  If
             specified as "user", only fields with non-default values are
             shown.  If specified as "default", the original values are
             returned.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "krb5": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies properties for the Kerberos authentication provider.", 
            "properties": {
              "status": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the status of the provider.", 
                "maxLength": 255
              }, 
              "realm": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the name of realm.", 
                "maxLength": 255
              }, 
              "name": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the Kerberos provider name.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "recommended_spns": {
                "type": [
                  {
                    "minItems": 0, 
                    "items": {
                      "minLength": 0, 
                      "type": "string", 
                      "maxLength": 2048
                    }, 
                    "type": "array", 
                    "description": "Specifies the recommended SPNs.", 
                    "maxItems": 4294967295
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "keytab_entries": {
                "type": [
                  {
                    "minItems": 0, 
                    "items": {
                      "type": "object", 
                      "description": "Krb5 SPN Key info", 
                      "properties": {
                        "encryption": {
                          "minItems": 0, 
                          "items": {
                            "minLength": 0, 
                            "type": "string", 
                            "maxLength": 255
                          }, 
                          "type": "array", 
                          "description": "Specifies the encryption types.", 
                          "maxItems": 4294967295
                        }, 
                        "kvno": {
                          "minimum": 0, 
                          "type": "integer", 
                          "description": "Specifies the version number of the SPN key.", 
                          "maximum": 4294967295
                        }, 
                        "spn": {
                          "minLength": 0, 
                          "type": "string", 
                          "description": "Specifies the Service Principal Name (SPN).", 
                          "maxLength": 2048
                        }, 
                        "timestamp": {
                          "minimum": 0, 
                          "type": "integer", 
                          "description": "Specifies the time the SPN key was created.", 
                          "maximum": 4294967295
                        }
                      }
                    }, 
                    "type": "array", 
                    "description": "Specifies the key information for the Kerberos SPNs.", 
                    "maxItems": 4294967295
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "system": {
                "type": [
                  {
                    "type": "boolean", 
                    "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed"
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "user": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the name of the user that performs kadmin tasks.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "keytab_file": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to a keytab file to import.", 
                "maxLength": 4096
              }, 
              "id": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the Kerberos provider ID.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "manual_keying": {
                "type": "boolean", 
                "description": "If true, keys are managed manually. If false, keys are managed through kadmin."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the KRB5 provider.

       URL: PUT /platform/<<version=1>>/auth/providers/krb5/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies properties for the Kerberos authentication provider.", 
  "properties": {
    "status": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the status of the provider.", 
      "maxLength": 255
    }, 
    "realm": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the name of realm.", 
      "maxLength": 255
    }, 
    "name": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the Kerberos provider name.", 
      "maxLength": 255
    }, 
    "keytab_entries": {
      "minItems": 0, 
      "items": {
        "type": "object", 
        "description": "Krb5 SPN Key info", 
        "properties": {
          "encryption": {
            "minItems": 0, 
            "items": {
              "minLength": 0, 
              "type": "string", 
              "maxLength": 255
            }, 
            "type": "array", 
            "description": "Specifies the encryption types.", 
            "maxItems": 4294967295
          }, 
          "kvno": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Specifies the version number of the SPN key.", 
            "maximum": 4294967295
          }, 
          "spn": {
            "minLength": 0, 
            "type": "string", 
            "description": "Specifies the Service Principal Name (SPN).", 
            "maxLength": 2048
          }, 
          "timestamp": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Specifies the time the SPN key was created.", 
            "maximum": 4294967295
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies the key information for the Kerberos SPNs.", 
      "maxItems": 4294967295
    }, 
    "user": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the name of the user that performs kadmin tasks.", 
      "maxLength": 255
    }, 
    "password": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the Kerberos provider password.", 
      "maxLength": 255
    }, 
    "keytab_file": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the path to a keytab file to import.", 
      "maxLength": 4096
    }, 
    "manual_keying": {
      "type": "boolean", 
      "description": "If true, keys are managed manually. If false, keys are managed through kadmin."
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the KRB5 provider.

          URL: DELETE /platform/<<version=1>>/auth/providers/krb5/<ID>

There are no query arguments for this method.

There is no JSON response body for this method.
